home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1998 November / Freeware November 1998.img / dist / fw_emacs.idb / usr / freeware / info / gnus-4.z / gnus-4 (.txt)
GNU Info File  |  1998-10-27  |  49KB  |  948 lines
  1. This is Info file ../info/gnus, produced by Makeinfo-1.63 from the
  2. input file gnus.texi.
  3.    This file documents Gnus, the GNU Emacs newsreader.
  4.    Copyright (C) 1995,96 Free Software Foundation, Inc.
  5.    Permission is granted to make and distribute verbatim copies of this
  6. manual provided the copyright notice and this permission notice are
  7. preserved on all copies.
  8.    Permission is granted to copy and distribute modified versions of
  9. this manual under the conditions for verbatim copying, provided also
  10. that the entire resulting derived work is distributed under the terms
  11. of a permission notice identical to this one.
  12.    Permission is granted to copy and distribute translations of this
  13. manual into another language, under the above conditions for modified
  14. versions.
  15. File: gnus,  Node: Article Buttons,  Next: Article Date,  Prev: Article Washing,  Up: Article Treatment
  16. Article Buttons
  17. ---------------
  18.    People often include references to other stuff in articles, and it
  19. would be nice if Gnus could just fetch whatever it is that people talk
  20. about with the minimum of fuzz.
  21.    Gnus adds "buttons" to certain standard references by default:
  22. Well-formed URLs, mail addresses and Message-IDs.  This is controlled by
  23. two variables, one that handles article bodies and one that handles
  24. article heads:
  25. `gnus-button-alist'
  26.      This is an alist where each entry has this form:
  27.           (REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
  28.     REGEXP
  29.           All text that match this regular expression will be
  30.           considered an external reference.  Here's a typical regexp
  31.           that match embedded URLs: `<URL:\\([^\n\r>]*\\)>'.
  32.     BUTTON-PAR
  33.           Gnus has to know which parts of the match is to be
  34.           highlighted.  This is a number that says what sub-expression
  35.           of the regexp that is to be highlighted.  If you want it all
  36.           highlighted, you use `0' here.
  37.     USE-P
  38.           This form will be `eval'ed, and if the result is non-`nil',
  39.           this is considered a match.  This is useful if you want extra
  40.           sifting to avoid false matches.
  41.     FUNCTION
  42.           This function will be called when you click on this button.
  43.     DATA-PAR
  44.           As with BUTTON-PAR, this is a sub-expression number, but this
  45.           one says which part of the match is to be sent as data to
  46.           FUNCTION.
  47.      So the full entry for buttonizing URLs is then
  48.           ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
  49. `gnus-header-button-alist'
  50.      This is just like the other alist, except that it is applied to the
  51.      article head only, and that each entry has an additional element
  52.      that is used to say what headers to apply the buttonize coding to:
  53.           (HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
  54.      HEADER is a regular expression.
  55. `gnus-button-url-regexp'
  56.      A regular expression that matches embedded URLs.  It is used in the
  57.      default values of the variables above.
  58. `gnus-article-button-face'
  59.      Face used on bottons.
  60. `gnus-article-mouse-face'
  61.      Face is used when the mouse cursor is over a button.
  62. File: gnus,  Node: Article Date,  Prev: Article Buttons,  Up: Article Treatment
  63. Article Date
  64. ------------
  65.    The date is most likely generated in some obscure timezone you've
  66. never heard of, so it's quite nice to be able to find out what the time
  67. was when the article was sent.
  68. `W T u'
  69.      Display the date in UT (aka. GMT, aka ZULU)
  70.      (`gnus-article-date-ut').
  71. `W T l'
  72.      Display the date in the local timezone (`gnus-article-date-local').
  73. `W T e'
  74.      Say how much time has (e)lapsed between the article was posted and
  75.      now (`gnus-article-date-lapsed').
  76. `W T o'
  77.      Display the original date (`gnus-article-date-original').  This can
  78.      be useful if you normally use some other conversion function and is
  79.      worried that it might be doing something totally wrong.  Say,
  80.      claiming that the article was posted in 1854.  Although something
  81.      like that is *totally* impossible.  Don't you trust me? *titter*
  82. File: gnus,  Node: Summary Sorting,  Next: Finding the Parent,  Prev: Article Treatment,  Up: The Summary Buffer
  83. Summary Sorting
  84. ===============
  85.    You can have the summary buffer sorted in various ways, even though I
  86. can't really see why you'd want that.
  87. `C-c C-s C-n'
  88.      Sort by article number (`gnus-summary-sort-by-number').
  89. `C-c C-s C-a'
  90.      Sort by author (`gnus-summary-sort-by-author').
  91. `C-c C-s C-s'
  92.      Sort by subject (`gnus-summary-sort-by-subject').
  93. `C-c C-s C-d'
  94.      Sort by date (`gnus-summary-sort-by-date').
  95. `C-c C-s C-i'
  96.      Sort by score (`gnus-summary-sort-by-score').
  97.    These functions will work both when you use threading and when you
  98. don't use threading.  In the latter case, all summary lines will be
  99. sorted, line by line.  In the former case, sorting will be done on a
  100. root-by-root basis, which might not be what you were looking for.  To
  101. toggle whether to use threading, type `T T' (*note Thread Commands::.).
  102. File: gnus,  Node: Finding the Parent,  Next: Alternative Approaches,  Prev: Summary Sorting,  Up: The Summary Buffer
  103. Finding the Parent
  104. ==================
  105.    If you'd like to read the parent of the current article, and it is
  106. not displayed in the summary buffer, you might still be able to.  That
  107. is, if the current group is fetched by NNTP, the parent hasn't expired
  108. and the `References' in the current article are not mangled, you can
  109. just press `^' or `A r' (`gnus-summary-refer-parent-article').  If
  110. everything goes well, you'll get the parent.  If the parent is already
  111. displayed in the summary buffer, point will just move to this article.
  112.    You can have Gnus fetch all articles mentioned in the `References'
  113. header of the article by pushing `A R'
  114. (`gnus-summary-refer-references').
  115.    You can also ask the NNTP server for an arbitrary article, no matter
  116. what group it belongs to.  `M-^' (`gnus-summary-refer-article') will
  117. ask you for a `Message-ID', which is one of those long thingies that
  118. look something like `<38o6up$6f2@hymir.ifi.uio.no>'.  You have to get
  119. it all exactly right.  No fuzzy searches, I'm afraid.
  120.    If the group you are reading is located on a backend that does not
  121. support fetching by `Message-ID' very well (like `nnspool'), you can
  122. set `gnus-refer-article-method' to an NNTP method.  It would, perhaps,
  123. be best if the NNTP server you consult is the same as the one that
  124. keeps the spool you are reading from updated, but that's not really
  125. necessary.
  126.    Most of the mail backends support fetching by `Message-ID', but do
  127. not do a particularly excellent job of it.  That is, `nnmbox' and
  128. `nnbabyl' are able to locate articles from any groups, while `nnml' and
  129. `nnfolder' are only able to locate articles that have been posted to
  130. the current group.  (Anything else would be too time consuming.)
  131. `nnmh' does not support this at all.
  132. File: gnus,  Node: Alternative Approaches,  Next: Tree Display,  Prev: Finding the Parent,  Up: The Summary Buffer
  133. Alternative Approaches
  134. ======================
  135.    Different people like to read news using different methods.  This
  136. being Gnus, we offer a small selection of minor modes for the summary
  137. buffers.
  138. * Menu:
  139. * Pick and Read::               First mark articles and then read them.
  140. * Binary Groups::               Auto-decode all articles.
  141. File: gnus,  Node: Pick and Read,  Next: Binary Groups,  Up: Alternative Approaches
  142. Pick and Read
  143. -------------
  144.    Some newsreaders (like `nn' and, uhm, `nn') use a two-phased reading
  145. interface.  The user first marks the articles she wants to read from a
  146. summary buffer.  Then she starts reading the articles with just an
  147. article buffer displayed.
  148.    Gnus provides a summary buffer minor mode that allows
  149. this--`gnus-pick-mode'.  This basically means that a few process mark
  150. commands become one-keystroke commands to allow easy marking, and it
  151. makes one additional command for switching to the summary buffer
  152. available.
  153.    Here are the available keystrokes when using pick mode:
  154. `SPACE'
  155.      Pick the article (`gnus-summary-mark-as-processable').
  156.      Unpick the article (`gnus-summary-unmark-as-processable').
  157.      Unpick all articles (`gnus-summary-unmark-all-processable').
  158.      Pick the thread (`gnus-uu-mark-thread').
  159.      Unpick the thread (`gnus-uu-unmark-thread').
  160.      Pick the region (`gnus-uu-mark-region').
  161.      Unpick the region (`gnus-uu-unmark-region').
  162.      Pick articles that match a regexp (`gnus-uu-mark-by-regexp').
  163.      Unpick articles that match a regexp (`gnus-uu-unmark-by-regexp').
  164.      Pick the buffer (`gnus-uu-mark-buffer').
  165.      Unpick the buffer (`gnus-uu-unmark-buffer').
  166. `RET'
  167.      Start reading the picked articles (`gnus-pick-start-reading').  If
  168.      given a prefix, mark all unpicked articles as read first.  If
  169.      `gnus-pick-display-summary' is non-`nil', the summary buffer will
  170.      still be visible when you are reading.
  171.    If this sounds like a good idea to you, you could say:
  172.      (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
  173.    `gnus-pick-mode-hook' is run in pick minor mode buffers.
  174. File: gnus,  Node: Binary Groups,  Prev: Pick and Read,  Up: Alternative Approaches
  175. Binary Groups
  176. -------------
  177.    If you spend much time in binary groups, you may grow tired of
  178. hitting `X u', `n', `RET' all the time.  `M-x gnus-binary-mode' is a
  179. minor mode for summary buffers that makes all ordinary Gnus article
  180. selection functions uudecode series of articles and display the result
  181. instead of just displaying the articles the normal way.
  182.    In fact, the only way to see the actual articles if you have turned
  183. this mode on is the `g' command (`gnus-binary-show-article').
  184.    `gnus-binary-mode-hook' is called in binary minor mode buffers.
  185. File: gnus,  Node: Tree Display,  Next: Mail Group Commands,  Prev: Alternative Approaches,  Up: The Summary Buffer
  186. Tree Display
  187. ============
  188.    If you don't like the normal Gnus summary display, you might try
  189. setting `gnus-use-trees' to `t'.  This will create (by default) an
  190. additional "tree buffer".  You can execute all summary mode commands in
  191. the tree buffer.
  192.    There are a few variables to customize the tree display, of course:
  193. `gnus-tree-mode-hook'
  194.      A hook called in all tree mode buffers.
  195. `gnus-tree-mode-line-format'
  196.      A format string for the mode bar in the tree mode buffers.  The
  197.      default is `Gnus: %%b [%A] %Z'.  For a list of legal specs, *note
  198.      Summary Buffer Mode Line::..
  199. `gnus-selected-tree-face'
  200.      Face used for highlighting the selected article in the tree
  201.      buffer.  The default is `modeline'.
  202. `gnus-tree-line-format'
  203.      A format string for the tree nodes.  The name is a bit of a
  204.      misnomer, though--it doesn't define a line, but just the node.
  205.      The default value is `%(%[%3,3n%]%)', which displays the first
  206.      three characters of the name of the poster.  It is vital that all
  207.      nodes are of the same length, so you *must* use `%4,4n'-like
  208.      specifiers.
  209.      Legal specs are:
  210.     `n'
  211.           The name of the poster.
  212.     `f'
  213.           The `From' header.
  214.     `N'
  215.           The number of the article.
  216.     `['
  217.           The opening bracket.
  218.     `]'
  219.           The closing bracket.
  220.     `s'
  221.           The subject.
  222.      *Note Formatting Variables::.
  223.      Variables related to the display are:
  224.     `gnus-tree-brackets'
  225.           This is used for differentiating between "real" articles and
  226.           "sparse" articles.  The format is ((REAL-OPEN . REAL-CLOSE)
  227.           (SPARSE-OPEN . SPARSE-CLOSE) (DUMMY-OPEN . DUMMY-CLOSE)), and
  228.           the default is `((?[ . ?]) (?( . ?)) (?{ . ?}))'.
  229.     `gnus-tree-parent-child-edges'
  230.           This is a list that contains the characters used for
  231.           connecting parent nodes to their children.  The default is
  232.           `(?- ?\\ ?|)'.
  233. `gnus-tree-minimize-window'
  234.      If this variable is non-`nil', Gnus will try to keep the tree
  235.      buffer as small as possible to allow more room for the other Gnus
  236.      windows.  If this variable is a number, the tree buffer will never
  237.      be higher than that number.  The default is `t'.
  238. `gnus-generate-tree-function'
  239.      The function that actually generates the thread tree.  Two
  240.      predefined functions are available:
  241.      `gnus-generate-horizontal-tree' and `gnus-generate-vertical-tree'
  242.      (which is the default).
  243.    Here's and example from a horizontal tree buffer:
  244.      {***}-(***)-[odd]-[Gun]
  245.           |     \[Jan]
  246.           |     \[odd]-[Eri]
  247.           |     \(***)-[Eri]
  248.           |           \[odd]-[Paa]
  249.           \[Bjo]
  250.           \[Gun]
  251.           \[Gun]-[Jor]
  252.    Here's the same thread displayed in a vertical tree buffer:
  253.      {***}
  254.        |--------------------------\-----\-----\
  255.      (***)                         [Bjo] [Gun] [Gun]
  256.        |--\-----\-----\                          |
  257.      [odd] [Jan] [odd] (***)                   [Jor]
  258.        |           |     |--\
  259.      [Gun]       [Eri] [Eri] [odd]
  260.                                |
  261.                              [Paa]
  262. File: gnus,  Node: Mail Group Commands,  Next: Various Summary Stuff,  Prev: Tree Display,  Up: The Summary Buffer
  263. Mail Group Commands
  264. ===================
  265.    Some commands only make sense in mail groups.  If these commands are
  266. illegal in the current group, they will raise a hell and let you know.
  267.    All these commands (except the expiry and edit commands) use the
  268. process/prefix convention (*note Process/Prefix::.).
  269. `B e'
  270.      Expire all expirable articles in the group
  271.      (`gnus-summary-expire-articles').
  272. `B M-C-e'
  273.      Expunge all the expirable articles in the group
  274.      (`gnus-summary-expire-articles-now').  This means that *all*
  275.      articles that are eligible for expiry in the current group will
  276.      disappear forever into that big `/dev/null' in the sky.
  277. `B DEL'
  278.      Delete the mail article.  This is "delete" as in "delete it from
  279.      your disk forever and ever, never to return again." Use with
  280.      caution.  (`gnus-summary-delete-article').
  281. `B m'
  282.      Move the article from one mail group to another
  283.      (`gnus-summary-move-article').
  284. `B c'
  285.      Copy the article from one group (mail group or not) to a mail group
  286.      (`gnus-summary-copy-article').
  287. `B C'
  288.      Crosspost the current article to some other group
  289.      (`gnus-summary-crosspost-article').  This will create a new copy of
  290.      the article in the other group, and the Xref headers of the
  291.      article will be properly updated.
  292. `B i'
  293.      Import an arbitrary file into the current mail newsgroup
  294.      (`gnus-summary-import-article').  You will be prompted for a file
  295.      name, a `From' header and a `Subject' header.
  296. `B r'
  297.      Respool the mail article (`gnus-summary-move-article').
  298. `B w'
  299.      Edit the current article (`gnus-summary-edit-article').  To finish
  300.      editing and make the changes permanent, type `C-c C-c'
  301.      (`gnus-summary-edit-article-done').
  302. `B q'
  303.      If you want to re-spool an article, you might be curious as to
  304.      what group the article will end up in before you do the
  305.      re-spooling.  This command will tell you
  306.      (`gnus-summary-respool-query').
  307.    If you move (or copy) articles regularly, you might wish to have Gnus
  308. suggest where to put the articles.  `gnus-move-split-methods' is a
  309. variable that uses the same syntax as `gnus-split-methods' (*note
  310. Saving Articles::.).  You may customize that variable to create
  311. suggestions you find reasonable.
  312. File: gnus,  Node: Various Summary Stuff,  Next: Exiting the Summary Buffer,  Prev: Mail Group Commands,  Up: The Summary Buffer
  313. Various Summary Stuff
  314. =====================
  315. * Menu:
  316. * Summary Group Information::         Information oriented commands.
  317. * Searching for Articles::            Multiple article commands.
  318. * Really Various Summary Commands::   Those pesky non-conformant commands.
  319. `gnus-summary-mode-hook'
  320.      This hook is called when creating a summary mode buffer.
  321. `gnus-summary-generate-hook'
  322.      This is called as the last thing before doing the threading and the
  323.      generation of the summary buffer.  It's quite convenient for
  324.      customizing the threading variables based on what data the
  325.      newsgroup has.  This hook is called from the summary buffer after
  326.      most summary buffer variables has been set.
  327. `gnus-summary-prepare-hook'
  328.      Is is called after the summary buffer has been generated.  You
  329.      might use it to, for instance, highlight lines or modify the look
  330.      of the buffer in some other ungodly manner.  I don't care.
  331. File: gnus,  Node: Summary Group Information,  Next: Searching for Articles,  Up: Various Summary Stuff
  332. Summary Group Information
  333. -------------------------
  334. `H f'
  335.      Try to fetch the FAQ (list of frequently asked questions) for the
  336.      current group (`gnus-summary-fetch-faq').  Gnus will try to get the
  337.      FAQ from `gnus-group-faq-directory', which is usually a directory
  338.      on a remote machine.  This variable can also be a list of
  339.      directories.  In that case, giving a prefix to this command will
  340.      allow you to choose between the various sites.  `ange-ftp'
  341.      probably will be used for fetching the file.
  342. `H d'
  343.      Give a brief description of the current group
  344.      (`gnus-summary-describe-group').  If given a prefix, force
  345.      rereading the description from the server.
  346. `H h'
  347.      Give a very brief description of the most important summary
  348.      keystrokes (`gnus-summary-describe-briefly').
  349. `H i'
  350.      Go to the Gnus info node (`gnus-info-find-node').
  351. File: gnus,  Node: Searching for Articles,  Next: Really Various Summary Commands,  Prev: Summary Group Information,  Up: Various Summary Stuff
  352. Searching for Articles
  353. ----------------------
  354. `M-s'
  355.      Search through all subsequent articles for a regexp
  356.      (`gnus-summary-search-article-forward').
  357. `M-r'
  358.      Search through all previous articles for a regexp
  359.      (`gnus-summary-search-article-backward').
  360.      This command will prompt you for a header field, a regular
  361.      expression to match on this field, and a command to be executed if
  362.      the match is made (`gnus-summary-execute-command').
  363. `M-&'
  364.      Perform any operation on all articles that have been marked with
  365.      the process mark (`gnus-summary-universal-argument').
  366. File: gnus,  Node: Really Various Summary Commands,  Prev: Searching for Articles,  Up: Various Summary Stuff
  367. Really Various Summary Commands
  368. -------------------------------
  369. `A D'
  370.      If the current article is a collection of other articles (for
  371.      instance, a digest), you might use this command to enter a group
  372.      based on the that article (`gnus-summary-enter-digest-group').
  373.      Gnus will try to guess what article type is currently displayed
  374.      unless you give a prefix to this command, which forces a "digest"
  375.      interpretation.  Basically, whenever you see a message that is a
  376.      collection of other messages on some format, you `A D' and read
  377.      these messages in a more convenient fashion.
  378. `C-t'
  379.      Toggle truncation of summary lines
  380.      (`gnus-summary-toggle-truncation').
  381.      Expand the summary buffer window (`gnus-summary-expand-window').
  382.      If given a prefix, force an `article' window configuration.
  383. File: gnus,  Node: Exiting the Summary Buffer,  Prev: Various Summary Stuff,  Up: The Summary Buffer
  384. Exiting the Summary Buffer
  385. ==========================
  386.    Exiting from the summary buffer will normally update all info on the
  387. group and return you to the group buffer.
  388. `Z Z'
  389.      Exit the current group and update all information on the group
  390.      (`gnus-summary-exit'). `gnus-summary-prepare-exit-hook' is called
  391.      before doing much of the exiting, and calls
  392.      `gnus-summary-expire-articles' by default.
  393.      `gnus-summary-exit-hook' is called after finishing the exiting
  394.      process.
  395. `Z E'
  396.      Exit the current group without updating any information on the
  397.      group (`gnus-summary-exit-no-update').
  398. `Z c'
  399.      Mark all unticked articles in the group as read and then exit
  400.      (`gnus-summary-catchup-and-exit').
  401. `Z C'
  402.      Mark all articles, even the ticked ones, as read and then exit
  403.      (`gnus-summary-catchup-all-and-exit').
  404. `Z n'
  405.      Mark all articles as read and go to the next group
  406.      (`gnus-summary-catchup-and-goto-next-group').
  407. `Z R'
  408.      Exit this group, and then enter it again
  409.      (`gnus-summary-reselect-current-group').  If given a prefix, select
  410.      all articles, both read and unread.
  411. `Z G'
  412. `M-g'
  413.      Exit the group, check for new articles in the group, and select the
  414.      group (`gnus-summary-rescan-group').  If given a prefix, select all
  415.      articles, both read and unread.
  416. `Z N'
  417.      Exit the group and go to the next group
  418.      (`gnus-summary-next-group').
  419. `Z P'
  420.      Exit the group and go to the previous group
  421.      (`gnus-summary-prev-group').
  422.    `gnus-exit-group-hook' is called when you exit the current group.
  423.    If you're in the habit of exiting groups, and then changing your mind
  424. about it, you might set `gnus-kill-summary-on-exit' to `nil'.  If you
  425. do that, Gnus won't kill the summary buffer when you exit it.  (Quelle
  426. surprise!)  Instead it will change the name of the buffer to something
  427. like `*Dead Summary ... *' and install a minor mode called
  428. `gnus-dead-summary-mode'.  Now, if you switch back to this buffer,
  429. you'll find that all keys are mapped to a function called
  430. `gnus-summary-wake-up-the-dead'.  So tapping any keys in a dead summary
  431. buffer will result in a live, normal summary buffer.
  432.    There will never be more than one dead summary buffer at any one
  433. time.
  434.    The data on the current group will be updated (which articles you
  435. have read, which articles you have replied to, etc.) when you exit the
  436. summary buffer.  If the `gnus-use-cross-reference' variable is `t'
  437. (which is the default), articles that are cross-referenced to this
  438. group and are marked as read, will also be marked as read in the other
  439. subscribed groups they were cross-posted to.  If this variable is
  440. neither `nil' nor `t', the article will be marked as read in both
  441. subscribed and unsubscribed groups.
  442.    Marking cross-posted articles as read ensures that you'll never have
  443. to read the same article more than once.  Unless, of course, somebody
  444. has posted it to several groups separately.  Posting the same article to
  445. several groups (not cross-posting) is called "spamming", and you are by
  446. law required to send nasty-grams to anyone who perpetrates such a
  447. heinous crime.
  448.    Remember: Cross-posting is kinda ok, but posting the same article
  449. separately to several groups is not.  Massive cross-posting (aka.
  450. "velveeta") is to be avoided.
  451.    One thing that may cause Gnus to not do the cross-posting thing
  452. correctly is if you use an NNTP server that supports XOVER (which is
  453. very nice, because it speeds things up considerably) which does not
  454. include the `Xref' header in its NOV lines.  This is Evil, but all too
  455. common, alas, alack.  Gnus tries to Do The Right Thing even with XOVER
  456. by registering the `Xref' lines of all articles you actually read, but
  457. if you kill the articles, or just mark them as read without reading
  458. them, Gnus will not get a chance to snoop the `Xref' lines out of these
  459. articles, and will be unable to use the cross reference mechanism.
  460.    To check whether your NNTP server includes the `Xref' header in its
  461. overview files, try `telnet your.nntp.server nntp', `MODE READER' on
  462. `inn' servers, and then say `LIST overview.fmt'.  This may not work,
  463. but if it does, and the last line you get does not read `Xref:full',
  464. then you should shout and whine at your news admin until she includes
  465. the `Xref' header in the overview files.
  466.    If you want Gnus to get the `Xref's right all the time, you have to
  467. set `gnus-nov-is-evil' to `t', which slows things down considerably.
  468.    C'est la vie.
  469. File: gnus,  Node: The Article Buffer,  Next: Composing Messages,  Prev: The Summary Buffer,  Up: Top
  470. The Article Buffer
  471. ******************
  472.    The articles are displayed in the article buffer, of which there is
  473. only one.  All the summary buffers share the same article buffer unless
  474. you tell Gnus otherwise.
  475. * Menu:
  476. * Hiding Headers::        Deciding what headers should be displayed.
  477. * Using MIME::            Pushing articles through MIME before reading them.
  478. * Customizing Articles::  Tailoring the look of the articles.
  479. * Article Keymap::        Keystrokes available in the article buffer
  480. * Misc Article::          Other stuff.
  481. File: gnus,  Node: Hiding Headers,  Next: Using MIME,  Up: The Article Buffer
  482. Hiding Headers
  483. ==============
  484.    The top section of each article is the "head".  (The rest is the
  485. "body", but you may have guessed that already.)
  486.    There is a lot of useful information in the head: the name of the
  487. person who wrote the article, the date it was written and the subject
  488. of the article.  That's well and nice, but there's also lots of
  489. information most people do not want to see--what systems the article
  490. has passed through before reaching you, the `Message-ID', the
  491. `References', etc. ad nauseum--and you'll probably want to get rid of
  492. some of those lines.  If you want to keep all those lines in the
  493. article buffer, you can set `gnus-show-all-headers' to `t'.
  494.    Gnus provides you with two variables for sifting headers:
  495. `gnus-visible-headers'
  496.      If this variable is non-`nil', it should be a regular expression
  497.      that says what headers you wish to keep in the article buffer.  All
  498.      headers that do not match this variable will be hidden.
  499.      For instance, if you only want to see the name of the person who
  500.      wrote the article and the subject, you'd say:
  501.           (setq gnus-visible-headers "^From:\\|^Subject:")
  502.      This variable can also be a list of regexps to match headers that
  503.      are to remain visible.
  504. `gnus-ignored-headers'
  505.      This variable is the reverse of `gnus-visible-headers'.  If this
  506.      variable is set (and `gnus-visible-headers' is `nil'), it should
  507.      be a regular expression that matches all lines that you want to
  508.      hide.  All lines that do not match this variable will remain
  509.      visible.
  510.      For instance, if you just want to get rid of the `References' line
  511.      and the `Xref' line, you might say:
  512.           (setq gnus-ignored-headers "^References:\\|^Xref:")
  513.      This variable can also be a list of regexps to match headers that
  514.      are to be removed.
  515.      Note that if `gnus-visible-headers' is non-`nil', this variable
  516.      will have no effect.
  517.    Gnus can also sort the headers for you.  (It does this by default.)
  518. You can control the sorting by setting the `gnus-sorted-header-list'
  519. variable.  It is a list of regular expressions that says in what order
  520. the headers are to be displayed.
  521.    For instance, if you want the name of the author of the article
  522. first, and then the subject, you might say something like:
  523.      (setq gnus-sorted-header-list '("^From:" "^Subject:"))
  524.    Any headers that are to remain visible, but are not listed in this
  525. variable, will be displayed in random order after all the headers that
  526. are listed in this variable.
  527.    You can hide further boring headers by entering
  528. `gnus-article-hide-boring-headers' into `gnus-article-display-hook'.
  529. What this function does depends on the `gnus-boring-article-headers'
  530. variable.  It's a list, but this list doesn't actually contain header
  531. names.  Instead is lists various "boring conditions" that Gnus can
  532. check and remove from sight.
  533.    These conditions are:
  534. `empty'
  535.      Remove all empty headers.
  536. `newsgroups'
  537.      Remove the `Newsgroups' header if it only contains the current
  538.      group name.
  539. `followup-to'
  540.      Remove the `Followup-To' header if it is identical to the
  541.      `Newsgroups' header.
  542. `reply-to'
  543.      Remove the `Reply-To' header if it lists the same address as the
  544.      `From' header.
  545. `date'
  546.      Remove the `Date' header if the article is less than three days
  547.      old.
  548.    To include the four first elements, you could say something like;
  549.      (setq gnus-boring-article-headers
  550.            '(empty newsgroups followup-to reply-to))
  551.    This is also the default value for this variable.
  552. File: gnus,  Node: Using MIME,  Next: Customizing Articles,  Prev: Hiding Headers,  Up: The Article Buffer
  553. Using MIME
  554. ==========
  555.    Mime is a standard for waving your hands through the air, aimlessly,
  556. while people stand around yawning.
  557.    MIME, however, is a standard for encoding your articles, aimlessly,
  558. while all newsreaders die of fear.
  559.    MIME may specify what character set the article uses, the encoding
  560. of the characters, and it also makes it possible to embed pictures and
  561. other naughty stuff in innocent-looking articles.
  562.    Gnus handles MIME by shoving the articles through
  563. `gnus-show-mime-method', which is `metamail-buffer' by default.  Set
  564. `gnus-show-mime' to `t' if you want to use MIME all the time.  However,
  565. if `gnus-strict-mime' is non-`nil', the MIME method will only be used
  566. if there are MIME headers in the article.
  567.    It might be best to just use the toggling functions from the summary
  568. buffer to avoid getting nasty surprises. (For instance, you enter the
  569. group `alt.sing-a-long' and, before you know it, MIME has decoded the
  570. sound file in the article and some horrible sing-a-long song comes
  571. streaming out out your speakers, and you can't find the volume button,
  572. because there isn't one, and people are starting to look at you, and
  573. you try to stop the program, but you can't, and you can't find the
  574. program to control the volume, and everybody else in the room suddenly
  575. decides to look at you disdainfully, and you'll feel rather stupid.)
  576.    Any similarity to real events and people is purely coincidental.
  577. Ahem.
  578. File: gnus,  Node: Customizing Articles,  Next: Article Keymap,  Prev: Using MIME,  Up: The Article Buffer
  579. Customizing Articles
  580. ====================
  581.    The `gnus-article-display-hook' is called after the article has been
  582. inserted into the article buffer.  It is meant to handle all treatment
  583. of the article before it is displayed.
  584.    By default it contains `gnus-article-hide-headers',
  585. `gnus-article-treat-overstrike', and `gnus-article-maybe-highlight',
  586. but there are thousands, nay millions, of functions you can put in this
  587. hook.  For an overview of functions *note Article Highlighting::.,
  588. *note Article Hiding::., *note Article Washing::., *note Article
  589. Buttons::. and *note Article Date::..
  590.    You can, of course, write your own functions.  The functions are
  591. called from the article buffer, and you can do anything you like,
  592. pretty much.  There is no information that you have to keep in the
  593. buffer--you can change everything.  However, you shouldn't delete any
  594. headers.  Instead make them invisible if you want to make them go away.
  595. File: gnus,  Node: Article Keymap,  Next: Misc Article,  Prev: Customizing Articles,  Up: The Article Buffer
  596. Article Keymap
  597. ==============
  598.    Most of the keystrokes in the summary buffer can also be used in the
  599. article buffer.  They should behave as if you typed them in the summary
  600. buffer, which means that you don't actually have to have a summary
  601. buffer displayed while reading.  You can do it all from the article
  602. buffer.
  603.    A few additional keystrokes are available:
  604. `SPACE'
  605.      Scroll forwards one page (`gnus-article-next-page').
  606. `DEL'
  607.      Scroll backwards one page (`gnus-article-prev-page').
  608. `C-c ^'
  609.      If point is in the neighborhood of a `Message-ID' and you press
  610.      `r', Gnus will try to get that article from the server
  611.      (`gnus-article-refer-article').
  612. `C-c C-m'
  613.      Send a reply to the address near point (`gnus-article-mail').  If
  614.      given a prefix, include the mail.
  615.      Reconfigure the buffers so that the summary buffer becomes visible
  616.      (`gnus-article-show-summary').
  617.      Give a very brief description of the available keystrokes
  618.      (`gnus-article-describe-briefly').
  619. `TAB'
  620.      Go to the next button, if any (`gnus-article-next-button'.  This
  621.      only makes sense if you have buttonizing turned on.
  622. `M-TAB'
  623.      Go to the previous button, if any (`gnus-article-prev-button'.
  624. File: gnus,  Node: Misc Article,  Prev: Article Keymap,  Up: The Article Buffer
  625. Misc Article
  626. ============
  627. `gnus-single-article-buffer'
  628.      If non-`nil', use the same article buffer for all the groups.
  629.      (This is the default.)  If `nil', each group will have its own
  630.      article buffer.
  631. `gnus-article-prepare-hook'
  632.      This hook is called right after the article has been inserted into
  633.      the article buffer.  It is mainly intended for functions that do
  634.      something depending on the contents; it should probably not be
  635.      used for changing the contents of the article buffer.
  636. `gnus-article-display-hook'
  637.      This hook is called as the last thing when displaying an article,
  638.      and is intended for modifying the contents of the buffer, doing
  639.      highlights, hiding headers, and the like.
  640. `gnus-article-mode-hook'
  641.      Hook called in article mode buffers.
  642. `gnus-article-mode-line-format'
  643.      This variable is a format string along the same lines as
  644.      `gnus-summary-mode-line-format'.  It accepts exactly the same
  645.      format specifications as that variable.
  646. `gnus-break-pages'
  647.      Controls whether "page breaking" is to take place.  If this
  648.      variable is non-`nil', the articles will be divided into pages
  649.      whenever a page delimiter appears in the article.  If this
  650.      variable is `nil', paging will not be done.
  651. `gnus-page-delimiter'
  652.      This is the delimiter mentioned above.  By default, it is `^L'
  653.      (form linefeed).
  654. File: gnus,  Node: Composing Messages,  Next: Select Methods,  Prev: The Article Buffer,  Up: Top
  655. Composing Messages
  656. ******************
  657.    All commands for posting and mailing will put you in a message buffer
  658. where you can edit the article all you like, before you send the article
  659. by pressing `C-c C-c'.  *Note Top: (message)Top.  If you are in a
  660. foreign news group, and you wish to post the article using the foreign
  661. server, you can give a prefix to `C-c C-c' to make Gnus try to post
  662. using the foreign server.
  663. * Menu:
  664. * Mail::                 Mailing and replying.
  665. * Post::                 Posting and following up.
  666. * Posting Server::       What server should you post via?
  667. * Mail and Post::        Mailing and posting at the same time.
  668. * Archived Messages::    Where Gnus stores the messages you've sent.
  669.    Also see *note Canceling and Superseding::. for information on how to
  670. remove articles you shouldn't have posted.
  671. File: gnus,  Node: Mail,  Next: Post,  Up: Composing Messages
  672.    Variables for customizing outgoing mail:
  673. `gnus-uu-digest-headers'
  674.      List of regexps to match headers included in digested messages.
  675.      The headers will be included in the sequence they are matched.
  676. File: gnus,  Node: Post,  Next: Posting Server,  Prev: Mail,  Up: Composing Messages
  677.    Variables for composing news articles:
  678. `gnus-sent-message-ids-file'
  679.      Gnus will keep a `Message-ID' history file of all the mails it has
  680.      sent.  If it discovers that it has already sent a mail, it will
  681.      ask the user whether to re-send the mail.  (This is primarily
  682.      useful when dealing with SOUP packets and the like where one is
  683.      apt to sent the same packet multiple times.)  This variable says
  684.      what the name of this history file is.  It is
  685.      `~/News/Sent-Message-IDs' by default.  Set this variable to `nil'
  686.      if you don't want Gnus to keep a history file.
  687. `gnus-sent-message-ids-length'
  688.      This variable says how many `Message-ID's to keep in the history
  689.      file.  It is 1000 by default.
  690. File: gnus,  Node: Posting Server,  Next: Mail and Post,  Prev: Post,  Up: Composing Messages
  691. Posting Server
  692. ==============
  693.    When you press those magical `C-c C-c' keys to ship off your latest
  694. (extremely intelligent, of course) article, where does it go?
  695.    Thank you for asking.  I hate you.
  696.    It can be quite complicated.  Normally, Gnus will use the same native
  697. server.  However.  If your native server doesn't allow posting, just
  698. reading, you probably want to use some other server to post your
  699. (extremely intelligent and fabulously interesting) articles.  You can
  700. then set the `gnus-post-method' to some other method:
  701.      (setq gnus-post-method '(nnspool ""))
  702.    Now, if you've done this, and then this server rejects your article,
  703. or this server is down, what do you do then?  To override this variable
  704. you can use a non-zero prefix to the `C-c C-c' command to force using
  705. the "current" server for posting.
  706.    If you give a zero prefix (i. e., `C-u 0 C-c C-c') to that command,
  707. Gnus will prompt you for what method to use for posting.
  708.    You can also set `gnus-post-method' to a list of select methods.  If
  709. that's the case, Gnus will always prompt you for what method to use for
  710. posting.
  711. File: gnus,  Node: Mail and Post,  Next: Archived Messages,  Prev: Posting Server,  Up: Composing Messages
  712. Mail and Post
  713. =============
  714.    Here's a list of variables that are relevant to both mailing and
  715. posting:
  716. `gnus-mailing-list-groups'
  717.      If your news server offers groups that are really mailing lists
  718.      that are gatewayed to the NNTP server, you can read those groups
  719.      without problems, but you can't post/followup to them without some
  720.      difficulty.  One solution is to add a `to-address' to the group
  721.      parameters (*note Group Parameters::.).  An easier thing to do is
  722.      set the `gnus-mailing-list-groups' to a regexp that match the
  723.      groups that really are mailing lists.  Then, at least, followups
  724.      to the mailing lists will work most of the time.  Posting to these
  725.      groups (`a') is still a pain, though.
  726.    You may want to do spell-checking on messages that you send out.
  727. Or, if you don't want to spell-check by hand, you could add automatic
  728. spell-checking via the `ispell' package:
  729.      (add-hook 'message-send-hook 'ispell-message)
  730. File: gnus,  Node: Archived Messages,  Prev: Mail and Post,  Up: Composing Messages
  731. Archived Messages
  732. =================
  733.    Gnus provides a few different methods for storing the mail you send.
  734. The default method is to use the "archive virtual server" to store the
  735. mail.  If you want to disable this completely, you should set
  736. `gnus-message-archive-group' to `nil'.
  737.    `gnus-message-archive-method' says what virtual server Gnus is to
  738. use to store sent messages.  It is `(nnfolder "archive"
  739. (nnfolder-directory "~/Mail/archive/"))' by default, but you can use any
  740. mail select method (`nnml', `nnmbox', etc.).  However, `nnfolder' is a
  741. quite likeable select method for doing this sort of thing.  If you
  742. don't like the default directory chosen, you could say something like:
  743.      (setq gnus-message-archive-method
  744.            '(nnfolder "archive"
  745.                       (nnfolder-inhibit-expiry t)
  746.                       (nnfolder-active-file "~/News/sent-mail/active")
  747.                       (nnfolder-directory "~/News/sent-mail/")))
  748.    Gnus will insert `Gcc' headers in all outgoing messages that point
  749. to one or more group(s) on that server.  Which group to use is
  750. determined by the `gnus-message-archive-group' variable.
  751.    This variable can be:
  752.    * a string Messages will be saved in that group.
  753.    * a list of strings Messages will be saved in all those groups.
  754.    * an alist of regexps, functions and forms When a key "matches", the
  755.      result is used.
  756.    Let's illustrate:
  757.    Just saving to a single group called `MisK':
  758.      (setq gnus-message-archive-group "MisK")
  759.    Saving to two groups, `MisK' and `safe':
  760.      (setq gnus-message-archive-group '("MisK" "safe"))
  761.    Save to different groups based on what group you are in:
  762.      (setq gnus-message-archive-group
  763.            '(("^alt" "sent-to-alt")
  764.              ("mail" "sent-to-mail")
  765.              (".*" "sent-to-misc")))
  766.    More complex stuff:
  767.      (setq gnus-message-archive-group
  768.            '((if (message-news-p)
  769.                  "misc-news"
  770.                "misc-mail")))
  771.    This is the default.
  772.    How about storing all news messages in one file, but storing all mail
  773. messages in one file per month:
  774.      (setq gnus-message-archive-group
  775.            '((if (message-news-p)
  776.                  "misc-news"
  777.                (concat "mail." (format-time-string
  778.                                 "%Y-%m" (current-time))))))
  779.    Now, when you send a message off, it will be stored in the
  780. appropriate group.  (If you want to disable storing for just one
  781. particular message, you can just remove the `Gcc' header that has been
  782. inserted.)  The archive group will appear in the group buffer the next
  783. time you start Gnus, or the next time you press `F' in the group
  784. buffer.  You can enter it and read the articles in it just like you'd
  785. read any other group.  If the group gets really big and annoying, you
  786. can simply rename if (using `G r' in the group buffer) to something
  787. nice - `misc-mail-september-1995', or whatever.  New messages will
  788. continue to be stored in the old (now empty) group.
  789.    That's the default method of archiving sent mail.  Gnus also offers
  790. two other variables for the people who don't like the default method.
  791. In that case you should set `gnus-message-archive-group' to `nil'; this
  792. will disable archiving.
  793.    XEmacs 19.13 doesn't have `format-time-string', so you'll have to
  794. use a different value for `gnus-message-archive-group' there.
  795. `gnus-outgoing-message-group'
  796.      All outgoing messages will be put in this group.  If you want to
  797.      store all your outgoing mail and articles in the group
  798.      `nnml:archive', you set this variable to that value.  This
  799.      variable can also be a list of group names.
  800.      If you want to have greater control over what group to put each
  801.      message in, you can set this variable to a function that checks the
  802.      current newsgroup name and then returns a suitable group name (or
  803.      list of names).
  804. File: gnus,  Node: Select Methods,  Next: Scoring,  Prev: Composing Messages,  Up: Top
  805. Select Methods
  806. **************
  807.    A "foreign group" is a group that is not read by the usual (or
  808. default) means.  It could be, for instance, a group from a different
  809. NNTP server, it could be a virtual group, or it could be your own
  810. personal mail group.
  811.    A foreign group (or any group, really) is specified by a "name" and
  812. a "select method".  To take the latter first, a select method is a list
  813. where the first element says what backend to use (eg. `nntp',
  814. `nnspool', `nnml') and the second element is the "server name".  There
  815. may be additional elements in the select method, where the value may
  816. have special meaning for the backend in question.
  817.    One could say that a select method defines a "virtual server"--so we
  818. do just that (*note The Server Buffer::.).
  819.    The "name" of the group is the name the backend will recognize the
  820. group as.
  821.    For instance, the group `soc.motss' on the NNTP server
  822. `some.where.edu' will have the name `soc.motss' and select method
  823. `(nntp "some.where.edu")'.  Gnus will call this group, in all
  824. circumstances, `nntp+some.where.edu:soc.motss', even though the `nntp'
  825. backend just knows this group as `soc.motss'.
  826.    The different methods all have their peculiarities, of course.
  827. * Menu:
  828. * The Server Buffer::     Making and editing virtual servers.
  829. * Getting News::          Reading USENET news with Gnus.
  830. * Getting Mail::          Reading your personal mail with Gnus.
  831. * Other Sources::         Reading directories, files, SOUP packets.
  832. * Combined Groups::       Combining groups into one group.
  833. File: gnus,  Node: The Server Buffer,  Next: Getting News,  Up: Select Methods
  834. The Server Buffer
  835. =================
  836.    Traditionally, a "server" is a machine or a piece of software that
  837. one connects to, and then requests information from.  Gnus does not
  838. connect directly to any real servers, but does all transactions through
  839. one backend or other.  But that's just putting one layer more between
  840. the actual media and Gnus, so we might just as well say that each
  841. backend represents a virtual server.
  842.    For instance, the `nntp' backend may be used to connect to several
  843. different actual NNTP servers, or, perhaps, to many different ports on
  844. the same actual NNTP server.  You tell Gnus which backend to use, and
  845. what parameters to set by specifying a "select method".
  846.    These select methods specifications can sometimes become quite
  847. complicated--say, for instance, that you want to read from the NNTP
  848. server `news.funet.fi' on port number `13', which hangs if queried for
  849. NOV headers and has a buggy select.  Ahem.  Anyways, if you had to
  850. specify that for each group that used this server, that would be too
  851. much work, so Gnus offers a way of naming select methods, which is what
  852. you do in the server buffer.
  853.    To enter the server buffer, user the `^'
  854. (`gnus-group-enter-server-mode') command in the group buffer.
  855. * Menu:
  856. * Server Buffer Format::      You can customize the look of this buffer.
  857. * Server Commands::           Commands to manipulate servers.
  858. * Example Methods::           Examples server specifications.
  859. * Creating a Virtual Server:: An example session.
  860. * Servers and Methods::       You can use server names as select methods.
  861. * Unavailable Servers::       Some servers you try to contact may be down.
  862.    `gnus-server-mode-hook' is run when creating the server buffer.
  863. File: gnus,  Node: Server Buffer Format,  Next: Server Commands,  Up: The Server Buffer
  864. Server Buffer Format
  865. --------------------
  866.    You can change the look of the server buffer lines by changing the
  867. `gnus-server-line-format' variable.  This is a `format'-like variable,
  868. with some simple extensions:
  869.      How the news is fetched--the backend name.
  870.      The name of this server.
  871.      Where the news is to be fetched from--the address.
  872.      The opened/closed/denied status of the server.
  873.    The mode line can also be customized by using the
  874. `gnus-server-mode-line-format' variable.  The following specs are
  875. understood:
  876.      Server name.
  877.      Server method.
  878.    Also *note Formatting Variables::..
  879. File: gnus,  Node: Server Commands,  Next: Example Methods,  Prev: Server Buffer Format,  Up: The Server Buffer
  880. Server Commands
  881. ---------------
  882.      Add a new server (`gnus-server-add-server').
  883.      Edit a server (`gnus-server-edit-server').
  884. `SPACE'
  885.      Browse the current server (`gnus-server-read-server').
  886.      Return to the group buffer (`gnus-server-exit').
  887.      Kill the current server (`gnus-server-kill-server').
  888.      Yank the previously killed server (`gnus-server-yank-server').
  889.      Copy the current server (`gnus-server-copy-server').
  890.      List all servers (`gnus-server-list-servers').
  891. File: gnus,  Node: Example Methods,  Next: Creating a Virtual Server,  Prev: Server Commands,  Up: The Server Buffer
  892. Example Methods
  893. ---------------
  894.    Most select methods are pretty simple and self-explanatory:
  895.      (nntp "news.funet.fi")
  896.    Reading directly from the spool is even simpler:
  897.      (nnspool "")
  898.    As you can see, the first element in a select method is the name of
  899. the backend, and the second is the "address", or "name", if you will.
  900.    After these two elements, there may be a arbitrary number of
  901. (VARIABLE FORM) pairs.
  902.    To go back to the first example--imagine that you want to read from
  903. port `15' from that machine.  This is what the select method should
  904. look like then:
  905.      (nntp "news.funet.fi" (nntp-port-number 15))
  906.    You should read the documentation to each backend to find out what
  907. variables are relevant, but here's an `nnmh' example.
  908.    `nnmh' is a mail backend that reads a spool-like structure.  Say you
  909. have two structures that you wish to access: One is your private mail
  910. spool, and the other is a public one.  Here's the possible spec for you
  911. private mail:
  912.      (nnmh "private" (nnmh-directory "~/private/mail/"))
  913.    (This server is then called `private', but you may have guessed
  914. that.)
  915.    Here's the method for a public spool:
  916.      (nnmh "public"
  917.            (nnmh-directory "/usr/information/spool/")
  918.            (nnmh-get-new-mail nil))
  919. File: gnus,  Node: Creating a Virtual Server,  Next: Servers and Methods,  Prev: Example Methods,  Up: The Server Buffer
  920. Creating a Virtual Server
  921. -------------------------
  922.    If you're saving lots of articles in the cache by using persistent
  923. articles, you may want to create a virtual server to read the cache.
  924.    First you need to add a new server.  The `a' command does that.  It
  925. would probably be best to use `nnspool' to read the cache.  You could
  926. also use `nnml' or `nnmh', though.
  927.    Type `a nnspool RET cache RET'.
  928.    You should now have a brand new `nnspool' virtual server called
  929. `cache'.  You now need to edit it to have the right definitions.  Type
  930. `e' to edit the server.  You'll be entered into a buffer that will
  931. contain the following:
  932.      (nnspool "cache")
  933.    Change that to:
  934.      (nnspool "cache"
  935.           (nnspool-spool-directory "~/News/cache/")
  936.           (nnspool-nov-directory "~/News/cache/")
  937.           (nnspool-active-file "~/News/cache/active"))
  938.    Type `C-c C-c' to return to the server buffer.  If you now press
  939. `RET' over this virtual server, you should be entered into a browse
  940. buffer, and you should be able to enter any of the groups displayed.
  941. File: gnus,  Node: Servers and Methods,  Next: Unavailable Servers,  Prev: Creating a Virtual Server,  Up: The Server Buffer
  942. Servers and Methods
  943. -------------------
  944.    Wherever you would normally use a select method (eg.
  945. `gnus-secondary-select-method', in the group select method, when
  946. browsing a foreign server) you can use a virtual server name instead.
  947. This could potentially save lots of typing.  And it's nice all over.
  948.